Note in docs that @dest's width and height is set to 0, 0 if the
authorBjörn Lindqvist <bjourne@gmail.com>
Fri, 10 Aug 2007 23:34:26 +0000 (23:34 +0000)
committerBjörn Lindqvist <bjornl@src.gnome.org>
Fri, 10 Aug 2007 23:34:26 +0000 (23:34 +0000)
2007-08-11  Björn Lindqvist  <bjourne@gmail.com>

* gdk/gdkrectangle.c (gdk_rectangle_intersect): Note in docs
        that @dest's width and height is set to 0, 0 if the rectangles
        does not intersect. (#464524)

svn path=/trunk/; revision=18602

gdk/gdkrectangle.c

index 0e13b14bbd46f03a7eb46b88c876f82c3b72d068..71679f98f7fb76e34e863a5dfda25deb352f7c8f 100644 (file)
@@ -64,8 +64,10 @@ gdk_rectangle_union (GdkRectangle *src1,
  * @src2: a #GdkRectangle
  * @dest: return location for the intersection of @src1 and @src2
  *
- * Calculates the intersection of two rectangles.
- * It is allowed for @dest to be the same as either @src1 or @src2.
+ * Calculates the intersection of two rectangles. It is allowed for
+ * @dest to be the same as either @src1 or @src2. If the rectangles
+ * doesn't intersect, @dest's width and height is set to 0 and its x
+ * and y values are undefined.
  *
  * Returns: %TRUE if the rectangles intersect.
  */